Skip to content

docs(schema-aware-routing): document OpenRouter as alternative provider#273

Open
jjshanks wants to merge 1 commit into
NateBJones-Projects:mainfrom
jjshanks:docs/schema-aware-routing-openrouter-provider
Open

docs(schema-aware-routing): document OpenRouter as alternative provider#273
jjshanks wants to merge 1 commit into
NateBJones-Projects:mainfrom
jjshanks:docs/schema-aware-routing-openrouter-provider

Conversation

@jjshanks
Copy link
Copy Markdown

@jjshanks jjshanks commented May 8, 2026

Fixes #266

Contribution Type

  • Recipe (/recipes)
  • Schema (/schemas)
  • Dashboard (/dashboards)
  • Integration (/integrations)
  • Skill (/skills)
  • Repo improvement (docs, CI, templates)

What does this do?

Adds OpenRouter as a first-class documented alternative alongside OpenAI direct in the schema-aware-routing recipe. Users who followed docs/01-getting-started.md Step 4 already have an OpenRouter account and key configured, so they no longer need to set up a separate OpenAI account just for this recipe. Step 2 now presents two copy-paste options (OpenAI direct and OpenRouter), JSDoc hints in index.ts cover both providers, and metadata.json is updated to reflect both paths. This is a pure documentation change — no logic, .env, or SQL edits.

Requirements

No new requirements. The recipe still needs:

  • An OpenAI-compatible API for LLM calls and embeddings — either OpenAI direct OR OpenRouter (canonical OB1 setup)
  • Node.js 18+ or Deno
  • @supabase/supabase-js

No new dependencies, skills, or primitives.

Checklist

  • I've read CONTRIBUTING.md
  • No credentials, API keys, or secrets are included

Add OpenRouter as a first-class documented option alongside OpenAI
direct in the schema-aware-routing recipe. Users who followed
docs/01-getting-started.md Step 4 already have OpenRouter configured,
so they no longer need to set up a separate OpenAI account just for
this recipe.

Changes:
- README.md: Prerequisites line updated to call out both paths
- README.md Step 2: Two concrete options — full copy-paste code for
  OpenAI direct (Option A) and OpenRouter (Option B) with key
  differences explained
- index.ts: JSDoc on extractMetadata() and getEmbedding() updated to
  show both endpoint URLs and model strings
- metadata.json: requires.services updated to reflect both providers

No code logic, .env files, or SQL changed — pure documentation.
@github-actions github-actions Bot added the recipe Contribution: step-by-step recipe label May 8, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 8, 2026

Hey @jjshanks — welcome to Open Brain Source! 👋

Thanks for submitting your first PR. The automated review will run shortly and check things like metadata, folder structure, and README completeness. If anything needs fixing, the review comment will tell you exactly what.

Once the automated checks pass, a human admin will review for quality and clarity. Expect a response within a few days.

If you have questions, check out CONTRIBUTING.md or open an issue.

@alanshurafa alanshurafa added area: recipes Review area: recipes review: ready-for-maintainer Community reviewer recommends maintainer review alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role labels May 20, 2026
@alanshurafa
Copy link
Copy Markdown
Collaborator

Thanks for the contribution. Documenting both provider options (OpenAI direct and OpenRouter) for the schema-aware-routing recipe is a useful addition and matches the canonical OB1 setup, which supports either. Small, additive change.

One note for the maintainer: #273 and #310 both modify recipes/schema-aware-routing/, so whichever lands first, the other will need a rebase. Recommend maintainer review.

— Alan (community reviewer; non-binding)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

alan-reviewed Reviewed by Alan Shurafa in Community Reviewer role area: recipes Review area: recipes recipe Contribution: step-by-step recipe review: ready-for-maintainer Community reviewer recommends maintainer review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[recipes] schema-aware-routing: add OpenRouter as an alternative provider (matches OB1 canonical setup)

2 participants